Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Fix: Accidentally deleted bin folder #1435

Merged
merged 1 commit into from
Sep 16, 2024

Conversation

roninjin10
Copy link
Collaborator

@roninjin10 roninjin10 commented Sep 16, 2024

Description

Concise description of proposed changes

Testing

Explain the quality checks that have been done on the code changes

Additional Information

Your ENS/address:

Summary by CodeRabbit

  • New Features

    • Restored the essential bin folder for proper application functionality.
    • Introduced a command-line interface (CLI) tool for generating TypeScript types from Solidity contracts, enhancing development efficiency.
    • Added a gen command to facilitate type generation based on user-defined patterns.
  • Bug Fixes

    • Addressed the issue of missing binaries by reinstating the deleted bin folder.

Copy link

changeset-bot bot commented Sep 16, 2024

🦋 Changeset detected

Latest commit: 3c31bda

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
tevm Patch
tevm-run Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Sep 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Updated (UTC)
tevm-monorepo-tevm ⬜️ Ignored (Inspect) Sep 16, 2024 7:04pm

@roninjin10 roninjin10 marked this pull request as ready for review September 16, 2024 19:04
Copy link
Collaborator Author

roninjin10 commented Sep 16, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @roninjin10 and the rest of your teammates on Graphite Graphite

Copy link
Contributor

coderabbitai bot commented Sep 16, 2024

Walkthrough

This pull request restores a previously deleted bin folder, which is essential for the project's structure. Additionally, it introduces a new tevm.js file that implements a command-line interface (CLI) tool for generating TypeScript types from Solidity contracts. The CLI utilizes various Node.js libraries and includes a caching mechanism for Solidity compilation, allowing users to generate types based on specified patterns.

Changes

File Path Change Summary
.../shiny-bulldogs-sniff.md Restored the bin folder, which contains essential binaries for application functionality.
tevm/bin/tevm.js Introduced a CLI tool for generating TypeScript types from Solidity contracts with a generate function and command gen.

Possibly related PRs

🐇 In the burrow, changes bloom,
A bin restored, dispelling gloom.
With tevm.js, types take flight,
Solidity's magic, shining bright.
Hops of joy in every line,
Code and bunnies, all align! 🐰✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai generate interesting stats about this repository and render them as a table.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range and nitpick comments (1)
tevm/bin/tevm.js (1)

62-82: LGTM! CLI setup is clear and user-friendly.

The CLI setup using the commander library is well-structured and provides a user-friendly interface for generating TypeScript types from Solidity contracts. The gen command is clearly defined with an include argument and a config option, allowing users to specify the necessary information for type generation.

One minor suggestion:

  • Consider adding validation for the include argument to ensure it is provided and not empty. This would help prevent any potential errors or unexpected behavior if the user forgets to provide the include pattern.
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f487e83 and 3c31bda.

Files selected for processing (2)
  • .changeset/shiny-bulldogs-sniff.md (1 hunks)
  • tevm/bin/tevm.js (1 hunks)
Additional comments not posted (1)
.changeset/shiny-bulldogs-sniff.md (1)

1-5: LGTM!

The changeset is well-formatted and the message accurately describes the purpose of the patch. Restoring the accidentally deleted bin folder is crucial for the proper functioning of the application, as it likely contains essential binaries or executables. This patch effectively addresses the oversight and reinstates the expected project organization and functionality, preventing potential runtime errors or issues related to missing components.

Comment on lines +45 to +60
const generate = (cwd, include) => {
console.log('Generating types from contracts...', { dir: cwd, include });
const files = glob.sync(include, { cwd });
if (files.length === 0) {
throw new Error('No files found');
}
files.forEach(async (file) => {
const fileName = file.split('/').at(-1);
const fileDir = file.split('/').slice(0, -1).join('/');
const config = runSync(loadConfig(cwd));
const solcCache = createCache(config.cacheDir, fao, cwd);
const plugin = bundler(config, console, fao, solc, solcCache);
const tsContent = await plugin.resolveTsModule(`./${file}`, cwd, false, true);
await writeFile(path.join(fileDir, `${fileName}.ts`), tsContent.code);
});
};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider improvements to enhance performance, error handling, and logging.

The generate function is responsible for generating TypeScript types from Solidity contracts. While the overall logic is sound, there are a few areas that could be improved:

  1. Performance: The function uses synchronous file operations, which may block the execution until all files are processed. Consider using asynchronous file operations to improve performance and avoid blocking the execution.

  2. Error Handling: The function relies on various external dependencies and file operations. It would be beneficial to add proper error handling for potential issues with file access, configuration loading, or Solidity compilation. This would help identify and troubleshoot any problems that may arise during the generation process.

  3. Logging and Progress Tracking: The function currently logs the current working directory and include pattern at the beginning. However, it would be helpful to provide more detailed logging or progress tracking throughout the generation process. This would give better visibility into the progress and status of the type generation for each file.

@roninjin10 roninjin10 merged commit 8da3c59 into main Sep 16, 2024
9 checks passed
@roninjin10 roninjin10 deleted the 09-16-_bug_fix_accidentally_deleted_bin_folder branch September 16, 2024 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant